/*
 * Copyright 2000-2023 JetBrains s.r.o.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * Class describing a key char
 */
public class KeyChar {

    // Char value
    private final char ch;
    // Dead or not
    private final boolean isDead;

    // Private constructor for an ordinal key char
    private KeyChar(char ch) {
        this.ch = ch;
        this.isDead = false;
    }

    // Private constructor for a dead key char
    private KeyChar(char ch, boolean isDead) {
        this.ch = ch;
        this.isDead = isDead;
    }

    // Helper method for an ordinal key char creation
    static KeyChar ch(char ch) {
        return new KeyChar(ch);
    }

    // Helper method for a dead key char creation
    static KeyChar dead(char ch) {
        return new KeyChar(ch, true);
    }

    // Returns dead marker
    boolean isDead() {
        return isDead;
    }

    // Returns char value
    char getChar() {
        return ch;
    }
}
